Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(release): generate release notes latex from toml #2108

Draft
wants to merge 5 commits into
base: develop
Choose a base branch
from

Conversation

wpbonelli
Copy link
Contributor

@wpbonelli wpbonelli commented Dec 17, 2024

Store release notes in a TOML file and build the develop.tex file from it at distribution time. Storing release notes in a structured form will allow using them elsewhere, e.g. in the nightly build and official release descriptions. This is a first step toward #2059.

This PR adds tomlkit and Jinja2 to the Python dependencies. I figure we might as well adopt Jinja for this since we have discussed adopting it here as in flopy sooner or later.


Checklist of items for pull request

  • Replaced section above with description of pull request
  • Referenced issue or pull request Show changelog on nightly build release page #2059
  • Ran ruff on new and modified python scripts in .doc, autotests, doc, distribution, pymake, and utils subdirectories.
  • Removed checklist items not relevant to this pull request

@wpbonelli wpbonelli added documentation Documentation changes code refactor Nonfunctional changes dependencies Dependency changes ci Continuous integration release Release- or distribution-related changes labels Dec 17, 2024
@wpbonelli wpbonelli added this to the 6.6.0 milestone Dec 17, 2024
@wpbonelli wpbonelli modified the milestones: 6.6.0, 6.7.0 Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Continuous integration code refactor Nonfunctional changes dependencies Dependency changes documentation Documentation changes release Release- or distribution-related changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant